<HTML>
<HEAD>
<TITLE>HELP - Enum</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - Enum</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_class','HowToDocument0',this)" class="pathLink">HowToDocument</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">Enum</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_member','Enum171347412','_description',this)" class="tabLinkActive">Description</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Source</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Call Graph</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<span class="paragraph1">HowToDocument::Enum</span>
<span class="padding">( Public Enumeration  )</span>
<div class="paddingAuthor">Author:  N.F.S Grundtvig (The members of this class inherits the author by default.) </div>
<div class="paragraph2">Enumeration documentation.<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2">Enumeration Values Table</div>
<div id="descEnum" class="paddingMembersTableDiv"><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Enumeration Values</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>Description</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eEnumVal1171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eEnumVal1',CAPTION,'<strong>Brief description</strong><BR>eEnumVal1 enum value description.');" onmouseout="return nd();">&nbsp;eEnumVal1</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_member','eEnumVal1171347412',this)">eEnumVal1</a> enum <b>value</b> description.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eEnumVal2171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eEnumVal2',CAPTION,'<strong>Brief description</strong><BR>eEnumVal2 enum value description.');" onmouseout="return nd();">&nbsp;eEnumVal2</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_member','eEnumVal2171347412',this)">eEnumVal2</a> enum <b>value</b> description.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eEnumVal3171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eEnumVal3',CAPTION,'<strong>Brief description</strong><BR>eEnumVal3 enum value description');" onmouseout="return nd();">&nbsp;eEnumVal3</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_member','eEnumVal3171347412',this)">eEnumVal3</a> enum <b>value</b> description<br>
</TD>
</TR>
</table>
</div>
<div class="contentAirBottom"></div>
<div class="paragraph2">Description</div>
<div id="descDesc" class="paddingMembers">Enumeration documentation.<br>
This must usually be done in the header file. The enumeration will appear on the overview list ("Public", "Protected, "Private tabs ) for classes, on directory "Globals" (if not part of a class) etc. The individual enum values, are shown in a table on the doc-page for the enumeration as is shown above.<br>
<br>
<div class="userParagraph3">Anonymous enumerations</div>
 Anonymous enumerations are not shown on any of the above lists. However the enum values are instead shown on all of these lists. This is quite useful if for instance one uses anonymous enum values as integer constants in classes.<br>
<br>
<div class="userParagraph3">This is how it looks in the source:</div>
   <table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
  <TR VALIGN="top">
  <TD class="paddingHeadMultiColumn2">
<pre class="codeExamples">
/** 
Enumeration documentation. This must usually be done in the header file.
enum Enum      { eEnumVal1,    ///&lt; eEnumVal1 enum #value# description.
                 eEnumVal2,    ///&lt; eEnumVal2 enum #value# description.
                 eEnumVal3     ///&lt; eEnumVal3 enum #value# description
};
*/
</pre>  </TD>
  </TR>
  </TABLE>
<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2">Source</div>
<div class="paddingMembers">The documentation for this Member was generated from the following file:</div>
<div class="paddingMembers"><LI><a href="#" onMouseOver="link('_file','HowtoDocument_h0',this); ">HowtoDocument.h</a><br></div>
<div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_member','_description');
</script>
